[DEPRECATED] Update a Custom Field

[DEPRECATED] Use form field endpoints instead. Update a specific custom field by id

PUT /v1/custom_fields/{id}

[DEPRECATED] Update a Custom Field

cURL

curl --request PUT \
  --url https://api.rootly.com/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "custom_fields",
    "attributes": {
      "label": "<string>",
      "description": "<string>",
      "shown": [
        "incident_form"
      ],
      "required": [
        "incident_form"
      ],
      "default": "<string>",
      "position": 123
    }
  }
}
'

200

{
  "data": {
    "id": "<string>",
    "type": "custom_fields",
    "attributes": {
      "label": "<string>",
      "shown": [
        "incident_form"
      ],
      "required": [
        "incident_form"
      ],
      "position": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "kind": "<string>",
      "enabled": true,
      "slug": "<string>",
      "description": "<string>",
      "default": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/vnd.api+json

data · object · required

Show child attributes

Response

200

application/vnd.api+json

custom_field updated

data · object · required

Show child attributes